home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.006 / xemacs-1 / lib / xemacs-19.13 / info / ilisp.info-1 < prev    next >
Encoding:
GNU Info File  |  1995-09-01  |  48.8 KB  |  1,411 lines
  1. This is Info file ../info/ilisp.info, produced by Makeinfo-1.55 from
  2. the input file ilisp.texinfo.
  3.  
  4.    This file documents ILISP.
  5.  
  6.    This is edition 0.11 of the ILISP manual for ILISP Version 5.5.
  7.  
  8.    Copyright (C) 1991,1992,1993 Todd Kaufmann
  9.  
  10.    Permission is granted to make and distribute verbatim copies of this
  11. manual provided the copyright notice and this permission notice are
  12. preserved on all copies.
  13.  
  14.    Permission is granted to copy and distribute modified versions of
  15. this manual under the conditions for verbatim copying, provided that
  16. the entire resulting derived work is distributed under the terms of a
  17. permission notice identical to this one.
  18.  
  19.    Permission is granted to copy and distribute translations of this
  20. manual into another language, under the above conditions for modified
  21. versions, except that this permission notice may be stated in a
  22. translation approved by the Foundation.
  23.  
  24. 
  25. File: ilisp.info,  Node: Top,  Next: Distribution,  Prev: (dir),  Up: (dir)
  26.  
  27.    This Info file documents ILISP, a GNU Emacs interface for a lisp
  28. running in a buffer.
  29.  
  30. * Menu:
  31.  
  32. * Distribution::                How to get the latest ILISP distribution.
  33.  
  34. * Acknowledgements::            Acknowledgements
  35. * Introduction::                An introduction to ILISP and its features.
  36. * Installation::                How to install ILISP.
  37. * Starting up::                 How to run a Lisp process using ILISP.
  38.  
  39. * Buffers of ILISP::            Buffers used by ILISP, and their commands.
  40. * ILISP Commands::
  41. * Customization::               Description of ILISP variables and hooks.
  42. * Dialects::                    How ILISP knows how to communicate with Lisp,
  43.                                     and how to define new dialects.
  44.  
  45. Indices:
  46. * Concept index::               General concepts.
  47. * Key index::                   ILISP key sequences.
  48. * Command index::               Commands by name.
  49. * Variable index::              Variables and hooks that influence ILISP's
  50.                                    behavior.
  51.  
  52. * Function index::              Internal Emacs Lisp functions.
  53.  
  54. 
  55. File: ilisp.info,  Node: Distribution,  Next: Acknowledgements,  Prev: Top,  Up: Top
  56.  
  57. How to get the latest ILISP distribution.
  58. *****************************************
  59.  
  60.    ILISP is "free"; this means that everyone is free to use it and free
  61. to redistribute it on a free basis.  ILISP is not in the public domain;
  62. it is copyrighted and there are restrictions on its distribution, but
  63. these restrictions are designed to permit everything that a good
  64. cooperating citizen would want to do.  What is not allowed is to try to
  65. prevent others from further sharing any version of ILISP that they might
  66. get from you.  The precise conditions appears following this section.
  67.  
  68.    The easiest way to get a copy of ILISP is from someone else who has
  69. it.  You need not ask for permission to do so, or tell any one else;
  70. just copy it.
  71.  
  72.    If you do start using the package, please send mail to
  73. `ilisp-request@lehman.com' so that I can keep a mailing list of users.
  74.  
  75.    Please send bugs, questions or suggestions for discussion to
  76. `ilisp@lehman.com'
  77.  
  78. * Menu:
  79.  
  80. * FTP directions::              FTP directions
  81.  
  82. 
  83. File: ilisp.info,  Node: FTP directions,  Up: Distribution
  84.  
  85. FTP directions
  86. ==============
  87.  
  88. You can anonymously ftp the source files from FTP.CS.CMU.EDU:
  89.  
  90.    * Ftp to ftp.cs.cmu.edu (128.2.206.173)
  91.  
  92.    * login as anonymous, with user@host as password
  93.  
  94.    * `cd /user/ai/lang/lisp/util/emacs/ilisp/57'
  95.  
  96.    * `binary'
  97.  
  98.    * `get ilisp.tgz'
  99.  
  100. Or get whatever single files you need.
  101.  
  102. Unpack and install:
  103.  
  104.    `uncompress ilisp.tar.Z; tar xf ilisp.tar'
  105.  
  106.    *Note Installation::.
  107.  
  108.    If you want to use Thinking Machines' completion code, then Ftp it
  109. from THINK.COM
  110.  
  111.    It no longer comes as part of the distribution.
  112.  
  113. 
  114. File: ilisp.info,  Node: Acknowledgements,  Next: Introduction,  Prev: Distribution,  Up: Top
  115.  
  116. Acknowledgements
  117. ****************
  118.  
  119.    ILISP replaces the standard inferior LISP mode.  ILISP is based on
  120. comint mode and derived from a number of different interfaces including
  121. Symbolics, cmulisp, and Thinking Machines.
  122.  
  123.    There are many people that have taken the time to report bugs, make
  124. suggestions and even better send code to fix bugs or implement new
  125. features.
  126.  
  127.    Thanks to Neil Smithline, David Braunegg, Fred White, Jim Healy,
  128. Larry Stead, Hans Chalupsky, Michael Ernst, Frank Ritter, Tom Emerson,
  129. David Duff, Dan Pierson, Michael Kashket, Jamie Zawinski, Bjorn Victor,
  130. Brian Dennis, Guido Bosch, Chuck Irvine, Thomas M. Breuel, Ben Hyde,
  131. Paul Fuqua (for the CMU-CL GC display code) and Marco Antoniotti for bug
  132. reports, suggestions and code.  My apologies to those whom I may have
  133. forgotten.
  134.  
  135.    Special thanks to Todd Kaufmann for the texinfo file, work on bridge,
  136. epoch-pop and for really exercising everything.
  137.  
  138.    Please send bug reports, fixes and extensions to `ilisp@lehman.com'
  139. so I can merge them into the master source.
  140.  
  141.      --Chris McConnell  18-Mar-91
  142.      --Ivan Vazquez     27-Jun-93
  143.  
  144. 
  145. File: ilisp.info,  Node: Introduction,  Next: Installation,  Prev: Acknowledgements,  Up: Top
  146.  
  147. Introduction
  148. ************
  149.  
  150.    ILISP is an interface from GNU Emacs to an inferior LISP.  It has the
  151. following features:
  152.  
  153.    * Runs under emacs-18, fsf emacs-19, and Lucid emacs-19.
  154.  
  155.    * Support for multiple LISP dialects including Lucid, Allegro and CMU
  156.      on multiple machines even at the same time.
  157.  
  158.    * Dynamically sized pop-up windows that can be buried and scrolled
  159.      from any window.
  160.  
  161.    * Packages are properly handled including the distinction between
  162.      exported and internal symbols.
  163.  
  164.    * Synchronous, asynchronous or batch eval and compile of files,
  165.      regions, definitions and sexps with optional switching and
  166.      automatic calling.
  167.  
  168.    * Arglist, documentation, describe, inspect and macroexpand.
  169.  
  170.    * Completion of filename components and LISP symbols including
  171.      partial matches.
  172.  
  173.    * Find source both with and without help from the inferior LISP,
  174.      including CLOS methods, multiple definitions and multiple files.
  175.  
  176.    * Edit the callers of a function with and without help from the
  177.      inferior LISP.
  178.  
  179.    * Trace/untrace a function.
  180.  
  181.    * `M-q' ("Fill-paragraph") works properly on paragraphs in comments,
  182.      strings and code.
  183.  
  184.    * Find unbalanced parentheses.
  185.  
  186.    * Super brackets.
  187.  
  188.    * Handles editing, entering and indenting full LISP expressions.
  189.  
  190.    * Next, previous, and similar history mechanism compatible with
  191.      comint.
  192.  
  193.    * Handles LISP errors.
  194.  
  195.    * Result histories are maintained in the inferior LISP.
  196.  
  197.    * Does not create spurious symbols and handles case issues.
  198.  
  199.    * Online manuals for ILISP and Common LISP.
  200.  
  201. 
  202. File: ilisp.info,  Node: Installation,  Next: Starting up,  Prev: Introduction,  Up: Top
  203.  
  204. How to install ILISP
  205. ********************
  206.  
  207.    Installation of ILISP and some initialization of your computing
  208. environment are described in this chapter.  Please read the following
  209. sections carefully before getting started with ILISP.
  210.  
  211.    If ILISP has already been installed at your location, you can
  212. probably skip ahead to "Autoloading."
  213.  
  214.    Note that jwz's byte-compiler is required when compiling ILISP.  If
  215. you don't have it, get it from
  216. `archive.cis.ohio-state.edu:/pub/gnu/emacs/elisp-archive/bytecomp2.tar.Z'
  217.  
  218.    You don't need it if you are running emacs version 19 as both the Fsf
  219. and Lucid releases include this in their distributions.
  220.  
  221. * Menu:
  222.  
  223. * Makefile configuration::
  224. * Files of ILISP::
  225. * Autoloading::                 How to define autoload entries.
  226.  
  227. 
  228. File: ilisp.info,  Node: Makefile configuration,  Next: Files of ILISP,  Up: Installation
  229.  
  230. Makefile configuration
  231. ======================
  232.  
  233.    Some configuration needs to be done before compiling the emacs-lisp
  234. files that comprise ILISP.  This should be done in the `Makefile-ilisp'
  235. file in the section of the file marked CONFIGURATION SECTION.
  236.  
  237.    First, set the `YOUR_EMACS' variable to be the pathname of the emacs
  238. you will be using ILISP with.  This is the emacs that will be used to
  239. compile ILISP with.
  240.  
  241.    If you don't have jwz's byte compiler in your standard load path then
  242. you will have to uncomment the `BYTECOMP' line and set it to point to
  243. the correct location of the bytecomp files.
  244.  
  245.    If you do not have comint already in your emacs ( both Fsf 19 and
  246. Lucid 19 do ) then uncomment the `USE_BUNDLED_COMINT' line.  This will
  247. cause the copy of `comint.el' to be moved from the `Extras' directory
  248. into the main ILISP directory.
  249.  
  250.    The advice section is left uncommented out in the distributed
  251. `Makefile-ilisp' because most people will not have `advice.elc' in
  252. their load path.  Only Lucid emacs 19.8 will have this in the standard
  253. distribution.  If you do have it in your load path, then to avoid
  254. having two copies in your load-path and avoiding future confusion then
  255. comment out both the `ADVICE' and `USE_BUNDLED_ADVICE' lines.
  256.  
  257.    You can then compile everything with the shell command
  258.  
  259.    `make -f Makefile-ilisp <your target here>''
  260.  
  261.    Where the possible targets are `emacs_18', `emacs_18_epoch',
  262. `emacs_18_menu', and `emacs_19'.
  263.  
  264.    Ignore any compilation warnings unless they result in ILISP not
  265. compiling completely.
  266.  
  267.    You should then copy relevant sections of `ilisp.emacs' to your
  268. `.emacs' or to the system-wide `default.el' file, depending on who will
  269. be using ILISP.
  270.  
  271.    You should add the directory where all of the ILISP emacs-lisp files
  272. reside to your `load-path'.  There is an example of this in
  273. `ilisp.emacs'
  274.  
  275.    The first time a dialect is started, the interface files will
  276. complain about not being compiled, just hit `i' to ignore the message.
  277. Once a lisp dialect is started up, you should execute the command
  278. `ilisp-compile-inits' which will compile the `*.lisp' files and write
  279. them to the same directory as the ilisp files.
  280.  
  281.    The binary files should have a unique extension for each different
  282. combination of architecture and LISP dialect.  You will need to change
  283. `ilisp-init-binary-extension' and `ilisp-init-binary-command' to get
  284. additional extensions.  The binary for each different architecture
  285. should be different.  If you want to build the interface files into a
  286. LISP world, you will also need to set `ilisp-load-inits' to `nil' in
  287. the same place that you change `ilisp-program' to load the LISP world.
  288.  
  289.    There is an `ilisp-site-hook' for initializing site specific stuff
  290. like program locations when ILISP is first loaded.  You may want to
  291. define appropriate autoloads in your system Emacs start up file.
  292.  
  293.    Example site init:
  294.      ;;; CMU site
  295.      (setq ilisp-site-hook
  296.            '(lambda ()
  297.              (setq ilisp-motd "CMU ILISP V%s")
  298.              (setq expand-symlinks-rfs-exists t)
  299.              (setq allegro-program "/usr/misc/.allegro/bin/cl")
  300.              (setq lucid-program "/usr/misc/.lucid/bin/lisp")))
  301.  
  302. 
  303. File: ilisp.info,  Node: Files of ILISP,  Next: Autoloading,  Prev: Makefile configuration,  Up: Installation
  304.  
  305. Files of ILISP
  306. ==============
  307.  
  308.    The files you need to use ilisp are:
  309.  
  310. `ilisp.emacs'
  311.      File with sample `.emacs' code for ILISP.
  312.  
  313. `symlink-fix.el'
  314.      Expand pathnames resolving links.
  315.  
  316. `completer.el'
  317.      Partial completion code.
  318.  
  319. `bridge.el'
  320.      Process to process communication.
  321.  
  322. `comint.el'
  323.      The basic comint abstraction.  You only need this if running
  324.      emacs-18.
  325.  
  326. `comint-ipc.el'
  327.      Extensions for sending commands and getting results.
  328.  
  329. `ilisp-ext.el'
  330.      Standalone lisp-mode extensions.
  331.  
  332. `ilisp-bug.el'
  333.      ILISP bug submittal code.
  334.  
  335. `compat.el'
  336.      Compatibility code between fsf-18, fsf-19 and lemacs-19.
  337.  
  338. `ilisp-inp.el'
  339.      Buffer input module.
  340.  
  341. `ilisp-def.el'
  342.      Variable definitions.
  343.  
  344. `ilisp-ind.el'
  345.      Indentation code.
  346.  
  347. `ilisp-mov.el'
  348.      Buffer-point movement code.
  349.  
  350. `ilisp-key.el'
  351.      Keymap setups, including `ilisp-lispm-bindings'.
  352.  
  353. `ilisp-doc.el'
  354.      ILISP mode documenation.
  355.  
  356. `ilisp-mod.el'
  357.      ILISP mode definition.
  358.  
  359. `ilisp-prn.el'
  360.      Parenthesis handling.
  361.  
  362. `ilisp-el.el'
  363.      Emacs-lisp additions.
  364.  
  365. `ilisp-sym.el'
  366.      ILISP symbol handling.
  367.  
  368. `ilisp-low.el'
  369.      Low level interface code.
  370.  
  371. `ilisp-hi.el'
  372.      High level interface code.
  373.  
  374. `ilisp-out.el'
  375.      Output handling, include typeout window (a popper replacement).
  376.  
  377. `ilisp-prc.el'
  378.      Process handling code.
  379.  
  380. `ilisp-val.el'
  381.      Buffer value interface.
  382.  
  383. `ilisp-rng.el'
  384.      Match ring code.
  385.  
  386. `ilisp-utl.el'
  387.      Misc. utilities.
  388.  
  389. `ilisp-hnd.el'
  390.      Error handling.
  391.  
  392. `ilisp-kil.el'
  393.      Interface to reset/kill/abort inferior lisp.
  394.  
  395. `ilisp-snd.el'
  396.      ilisp-send definitions and associated code.
  397.  
  398. `ilisp-cmt.el'
  399.      Comint related code/setup.
  400.  
  401. `ilisp-cmp.el'
  402.      ILISP completer related code.
  403.  
  404. `ilisp-xfr.el'
  405.      Transfer between lisp <-> emacs code.
  406.  
  407. `ilisp-cl.el'
  408.      Commo-Lisp dialect definition.
  409.  
  410. `ilisp-src.el'
  411.      ILISP source code module.
  412.  
  413. `ilisp-bat.el'
  414.      ILISP batch code module.
  415.  
  416. `ilisp.el'
  417.      File to be loaded, loads in all necessary parts of ILISP.
  418.  
  419. `*.lisp'
  420.      ILISP support code.  Each dialect will have one of these files.
  421.  
  422. `*.lcd'
  423.      Package descriptors for the Lisp Code Directory.
  424.  
  425. `ilisp.texi'
  426.      Texinfo file for ILISP.
  427.  
  428. 
  429. File: ilisp.info,  Node: Autoloading,  Prev: Files of ILISP,  Up: Installation
  430.  
  431. How to define autoload entries
  432. ==============================
  433.  
  434.    A complete example of things you may want to add to your `.emacs'
  435. can be found in the in the file `ilisp.emacs' in the `ilisp-directory'
  436. what follows is that file.
  437.  
  438.      ;;;
  439.      ;;; This file shows examples of some of the things you might want to
  440.      ;;; do to install or customize ILISP.  You may not want to include all
  441.      ;;; of them in your .emacs.  For example, the default key binding
  442.      ;;; prefix for ILISP is C-z and this file changes the default prefix to
  443.      ;;; C-c.  For more information on things that can be changed, see the
  444.      ;;; file ilisp.el.
  445.      ;;;
  446.      
  447.      ;;; If ilisp lives in some non-standard directory, you must tell emacs
  448.      ;;; where to get it. This may or may not be necessary.
  449.      (setq load-path (cons (expand-file-name "~jones/emacs/ilisp/") load-path))
  450.      
  451.      ;;; If you always want partial minibuffer completion
  452.      (require 'completer)
  453.      
  454.      ;;; If want TMC completion then you will have to Ftp it yourself from think.com
  455.      ;;; It's become to flaky for me to deal with. -- Ivan
  456.      ;;;(load "completion")
  457.      ;;;(initialize-completions)
  458.      
  459.      ;;; If you want to redefine typeout-window keys:
  460.      (add-hook 'ilisp-load-hook
  461.            '(lambda ()
  462.          (define-key global-map "\C-c1" 'ilisp-bury-output)
  463.          (define-key global-map "\C-cv" 'ilisp-scroll-output)
  464.          (define-key global-map "\C-cg" 'ilisp-grow-output)))
  465.      
  466.      
  467.      (autoload 'run-ilisp "ilisp" "Select a new inferior LISP." t)
  468.      ;;; Autoload based on your LISP.  You only really need the one you use.
  469.      ;;; If called with a prefix, you will be prompted for a buffer and
  470.      ;;; program.
  471.      ;;;
  472.      ;;; [Back to the old way now -- Ivan Mon Jun 28 23:30:51 1993]
  473.      ;;;
  474.      (autoload 'clisp     "ilisp" "Inferior generic Common LISP." t)
  475.      (autoload 'allegro   "ilisp" "Inferior Allegro Common LISP." t)
  476.      (autoload 'lucid     "ilisp" "Inferior Lucid Common LISP." t)
  477.      (autoload 'cmulisp   "ilisp" "Inferior CMU Common LISP." t)
  478.      (autoload 'kcl       "ilisp" "Inferior Kyoto Common LISP." t)
  479.      (autoload 'akcl      "ilisp" "Inferior Austin Kyoto Common LISP." t)
  480.      (autoload 'ibcl      "ilisp" "Ibuki Common LISP." t)
  481.      (autoload 'scheme    "ilisp" "Inferior generic Scheme." t)
  482.      (autoload 'oaklisp   "ilisp" "Inferior Oaklisp Scheme." t)
  483.      
  484.      ;;; Define where LISP programs are found.  (This may already be done
  485.      ;;; at your site.)
  486.      (setq allegro-program "/usr/misc/.allegro/bin/cl")
  487.      (setq lucid-program "/usr/misc/.lucid/bin/lisp")
  488.      (setq cmulisp-program "/usr/misc/.cmucl/bin/lisp")
  489.      
  490.      ;;; If you run cmu-cl then set this to where your source files are.
  491.      (setq cmulisp-local-source-directory
  492.            "/usr/local/utils/CMU-CL/")
  493.      
  494.      
  495.      ;;; This makes reading a lisp file load in ilisp.
  496.      (set-default 'auto-mode-alist
  497.               (append '(("\\.lisp$" . lisp-mode)) auto-mode-alist))
  498.      (setq lisp-mode-hook '(lambda () (require 'ilisp)))
  499.      
  500.      ;;; Sample load hook
  501.      (add-hook 'ilisp-load-hook
  502.            '(lambda ()
  503.              ;; Change default key prefix to C-c
  504.              (setq ilisp-prefix "\C-c")
  505.      
  506.              ;; Define LispMachine-like key bindings, too.
  507.              (ilisp-lispm-bindings)
  508.      
  509.              ;; Sample initialization hook.  Set the inferior LISP directory to
  510.              ;; the directory of the buffer that spawned it on the first prompt.
  511.              (setq ilisp-init-hook
  512.               '(lambda ()
  513.                 (default-directory-lisp ilisp-last-buffer)))))
  514.  
  515. 
  516. File: ilisp.info,  Node: Starting up,  Next: Buffers of ILISP,  Prev: Installation,  Up: Top
  517.  
  518. How to run a Lisp process using ILISP
  519. *************************************
  520.  
  521.    To start a Lisp use `M-x run-ilisp', or a specific dialect like `M-x
  522. allegro'.  If called with a prefix you will be prompted for a buffer
  523. name and a program to run.  The default buffer name is the name of the
  524. dialect.  The default program for a dialect will be the value of
  525. DIALECT-program or the value of ilisp-program inherited from a less
  526. specific dialect.  If there are multiple LISP's, use the dialect name or
  527. `M-x select-ilisp' (`C-z S') to select the current ILISP buffer.
  528.  
  529.    Entry into ILISP mode runs the hooks on `comint-mode-hook' and
  530. `ilisp-mode-hook' and then DIALECT-hooks specific to LISP dialects in
  531. the nesting order above.  Many dialects call `ilisp-load-init' in their
  532. dialect setup.
  533.  
  534.    These are the currently supported dialects.  The dialects are listed
  535. so that the indentation correponds to the hierarchical relationship
  536. between dialects.
  537.       clisp
  538.         allegro
  539.         lucid
  540.         kcl
  541.           akcl
  542.           ibcl
  543.         cmulisp
  544.       scheme
  545.         oaklisp
  546.  
  547.    If anyone figures out support for other dialects I would be happy to
  548. include it in future releases.  *Note Dialects::.
  549.  
  550.    To define a new dialect, *Note Defining new dialects:: and *Note
  551. Customization::.
  552.  
  553. 
  554. File: ilisp.info,  Node: Buffers of ILISP,  Next: ILISP Commands,  Prev: Starting up,  Up: Top
  555.  
  556. Buffers used by ILISP, and their commands
  557. *****************************************
  558.  
  559. `*DIALECT*'
  560.      The Lisp listener buffer.  Forms can be entered in this buffer in,
  561.      and they will be sent to lisp when you hit return if the form is
  562.      complete.  This buffer is in ilisp-mode, which is built on top of
  563.      comint-mode, and all comint commands such as history mechanism and
  564.      job control are available.
  565.  
  566. `LISP-MODE-BUFFERS'
  567.      A buffer is assumed to contain Lisp source code if its major mode
  568.      is in the list `lisp-source-modes'.  If it's loaded into a buffer
  569.      that is in one of these major modes, it's considered a lisp source
  570.      file by `find-file-lisp', `load-file-lisp' and `compile-file-lisp'.
  571.      Used by these commands to determine defaults.
  572.  
  573. ``*Completions*''
  574.      Used for listing completions of symbols or files by the completion
  575.      commands.  *Note Completion::.
  576.  
  577. `*Aborted Commands*'
  578.      *Note Interrupts::.
  579.  
  580. `*Errors*'
  581. `*Output*'
  582. `*Error Output*'
  583.      used to pop-up results and errors from the inferior LISP.
  584.  
  585. `*ilisp-send*'
  586.      Buffer containing the last form sent to the inferior LISP.
  587.  
  588. `*Edit-Definitions*'
  589. `*All-Callers*'
  590.      *Note Source code commands::.
  591.  
  592. `*Last-Changes*'
  593. `*Changed-Definitions*'
  594.      *Note Batch commands::.
  595.  
  596. * Menu:
  597.  
  598. * Typeout windows::              temporary windows used for display.
  599. * Switching buffers::           Switching buffers
  600.  
  601. 
  602. File: ilisp.info,  Node: Typeout windows,  Next: Switching buffers,  Up: Buffers of ILISP
  603.  
  604. Typeout windows
  605. ===============
  606.  
  607.    All ILISP output is funneled through the function which is bound to
  608. the hook `ilisp-display-output-function'.  The function gets a single
  609. argument, a string, and should make that output visible to the user
  610. somehow.
  611.  
  612.    One possible choice for output display is
  613. `ilisp-display-output-in-typeout-window', which pops up a window at the
  614. top of the current screen which is just large enough to display the
  615. output.  This window can be "remote controlled" by the commands
  616. `ilisp-scroll-output', `ilisp-bury-output', and `ilisp-grow-output'.
  617.  
  618.    Unlike the old popper facility, the ilisp typeout window facility
  619. does not trounce on any existing Emacs functions or on any common key
  620. bindings, like `C-x o'.
  621.  
  622.    Other built-in functions which might be useful as values for
  623. `ilisp-display-output-function' include `ilisp-display-output-default',
  624. `ilisp-display-output-adaptively',
  625. `ilisp-display-output-in-lisp-listener',
  626. `ilisp-display-output-in-temp-buffer', and
  627. `ilisp-display-output-in-typeout-window'.
  628.  
  629.    The default display function is `ilisp-display-output-default',
  630. which obeys the `lisp-no-popper' variable.
  631.  
  632.    Users are encouraged to write their own output display functions to
  633. get the exact desired behavior, displaying on a private emacs screen,
  634. in a pop-up dialog box, or whetever.
  635.  
  636. `C-z 1   (ilisp-bury-output)'
  637.      deletes and buries the typeout output window.
  638.  
  639. `C-z v   (ilisp-scroll-output)'
  640.      scrolls the output window if it is showing, otherwise does nothing.
  641.      If it is called with a negative prefix, it will scroll backwards.
  642.  
  643. `C-z G   (ilisp-grow-output)'
  644.      will grow the output window if showing by the prefix number of
  645.      lines.
  646.  
  647.    An alternative to typeout windows is to always have the inferior LISP
  648. buffer visible and have all output go there.  Setting `lisp-no-popper'
  649. to `t' will cause all output to go to the inferior LISP buffer.
  650. Setting `lisp-no-popper' to `'message' will make output of one line go
  651. to the message window. Setting `comint-always-scroll' to `t' will cause
  652. process output to always be visible.  If a command gets an error, you
  653. will be left in the break loop.
  654.  
  655. 
  656. File: ilisp.info,  Node: Switching buffers,  Prev: Typeout windows,  Up: Buffers of ILISP
  657.  
  658. Switching buffers
  659. =================
  660.  
  661.    Commands to make switching between buffers easier.
  662.  
  663. `C-z b   (switch-to-lisp)'
  664.      will pop to the current ILISP buffer or if already in an ILISP
  665.      buffer, it will return to the buffer that last switched to an
  666.      ILISP buffer.  With a prefix, it will also go to the end of the
  667.      buffer.  If you do not want it to pop, set `pop-up-windows' to nil.
  668.  
  669. `M-C-l   (previous-buffer-lisp)'
  670.      will switch to the last visited buffer in the current window or
  671.      the Nth previous buffer with a prefix.
  672.  
  673. 
  674. File: ilisp.info,  Node: ILISP Commands,  Next: Customization,  Prev: Buffers of ILISP,  Up: Top
  675.  
  676. ILISP Commands
  677. **************
  678.  
  679.    Most of these key bindings work in both Lisp Mode and ILISP mode.
  680. There are a few additional and-go bindings found in Lisp Mode.
  681.  
  682. * Menu:
  683.  
  684. * Eval and compile functions::
  685. * Documentation functions::
  686. * Macroexpansion::
  687. * Tracing functions::
  688. * Package Commands::
  689. * Source code commands::        Working on several files
  690. * Batch commands::              Grouping changes for eval/compile
  691. * Files and directories::
  692. * Keyboard modes::              Interactive and raw keyboard modes
  693. * Interrupts::                  Interrupts, aborts, and errors
  694. * Command history::
  695. * Completion::
  696. * Miscellany::                  Indentation, parenthesis balancing,
  697.                   and comment commands.
  698.  
  699. 
  700. File: ilisp.info,  Node: Eval and compile functions,  Next: Documentation functions,  Up: ILISP Commands
  701.  
  702. Eval and compile functions
  703. ==========================
  704.  
  705.    In LISP, the major unit of interest is a form, which is anything
  706. between two matching parentheses.  Some of the commands here also refer
  707. to "defun," which is a list that starts at the left margin in a LISP
  708. buffer, or after a prompt in the ILISP buffer.  These commands refer to
  709. the "defun" that contains the point.
  710.  
  711.    "A call" refers to a reference to a function call for a function or
  712. macro, or a reference to a variable.  Commands which "insert a call" in
  713. the ILISP buffer will bring up the last command which matches it or
  714. else will insert a template for a call.
  715.  
  716.    When an eval is done of a single form matching `ilisp-defvar-regexp'
  717. the corresponding symbol will be unbound and the value assigned again.
  718.  
  719.    When you send a form to LISP, the status light will reflect the
  720. progress of the command.  In a lisp mode buffer the light will reflect
  721. the status of the currently selected inferior LISP unless
  722. `lisp-show-status' is nil.  If you want to find out what command is
  723. currently running, use the command `C-z s' (status-lisp).  If you call
  724. it with a prefix, the pending commands will be displayed as well.
  725.  
  726.    Note that in this table as elsewhere, the key C-z (ilisp-prefix) is
  727. used as a prefix character for ILISP commands, though this may be
  728. changed.  For a full list of key-bindings, use `M-x describe-mode' or
  729. `M-x describe-bindings' while in an ILISP-mode buffer.
  730.  
  731.    The eval/compile commands verify that their expressions are balanced
  732. and then send the form to the inferior LISP.  If called with a positive
  733. prefix, the result of the operation will be inserted into the buffer
  734. after the form that was just sent.
  735.  
  736.    For commands which operate on a region, the result of the compile or
  737. eval is the last form in the region.
  738.  
  739.    The `and-go' versions will perform the operation and then
  740. immediately switch to the ILISP buffer where you will see the results of
  741. executing your form.  If `eval-defun-and-go-lisp' or
  742. `compile-defun-and-go-lisp' is called with a prefix, a call for the
  743. form will be inserted as well.
  744.  
  745. `C-z'
  746.      The prefix-key for most ILISP commands.  This can be changed by
  747.      setting the variable `ilisp-prefix'.
  748.  
  749. `RET   (return-ilisp)'
  750.      In ILISP-mode buffer, sends the current form to lisp if complete,
  751.      otherwise creates a new line and indents.  If you edit old input,
  752.      the input will be copied to the end of the buffer first and then
  753.      sent.
  754.  
  755. `C-]   (close-and-send-lisp)'
  756.      Closes the current sexp, indents it, and then sends it to the
  757.      current inferior LISP.
  758.  
  759. `LFD   (newline-and-indent-lisp)'
  760.      Insert a new line and then indent to the appropriate level.  If
  761.      called at the end of the inferior LISP buffer and an sexp, the
  762.      sexp will be sent to the inferior LISP without a trailing newline.
  763.  
  764. `C-z e   (eval-defun-lisp)'
  765. `M-C-x   (eval-defun-lisp)'
  766. `C-z C-e   (eval-defun-and-go-lisp)'
  767.      Send the defun to lisp.
  768.  
  769. `C-z r   (eval-region-lisp)'
  770. `C-z C-r   (eval-region-and-go-lisp)'
  771. `C-z n   (eval-next-sexp-lisp)'
  772. `C-z C-n   (eval-next-sexp-and-go-lisp)'
  773. `C-z c   (compile-defun-lisp)'
  774. `C-z C-c   (compile-defun-lisp-and-go)'
  775.      When `compile-defun-lisp' is called in an inferior LISP buffer with
  776.      no current form, the last form typed to the top-level will be
  777.      compiled.
  778.  
  779. `C-z w   (compile-region-lisp)'
  780. `C-z C-w   (compile-region-and-go-lisp)'
  781.    If any of the forms contain an interactive command, then the command
  782. will never return.  To get out of this state, you need to use
  783. `abort-commands-lisp' (`C-z g').  If `lisp-wait-p' is t, then EMACS
  784. will display the result of the command in the minibuffer or a pop-up
  785. window.  If `lisp-wait-p' is `nil', (the default) the send is done
  786. asynchronously and the results will be brought up only if there is more
  787. than one line or there is an error.  In this case, you will be given
  788. the option of ignoring the error, keeping it in another buffer or
  789. keeping it and aborting all pending sends.  If there is not a command
  790. already running in the inferior LISP, you can preserve the break loop.
  791. If called with a negative prefix, the sense of `lisp-wait-p' will be
  792. inverted for the next command.
  793.  
  794. 
  795. File: ilisp.info,  Node: Documentation functions,  Next: Macroexpansion,  Prev: Eval and compile functions,  Up: ILISP Commands
  796.  
  797. Documentation functions
  798. =======================
  799.  
  800.    `describe-lisp', `inspect-lisp', `arglist-lisp', and
  801. `documentation-lisp' switch whether they prompt for a response or use a
  802. default when called with a negative prefix.  If they are prompting,
  803. there is completion through the inferior LISP by using `TAB' or
  804. `M-TAB'.  When entering an expression in the minibuffer, all of the
  805. normal ilisp commands like `arglist-lisp' also work.
  806.  
  807.    Commands that work on a function will use the nearest previous
  808. function symbol.  This is either a symbol after a `#'' or the symbol at
  809. the start of the current list.
  810.  
  811. `C-z a   (arglist-lisp)'
  812.      Return the arglist of the current function.  With a numeric
  813.      prefix, the leading paren will be removed and the arglist will be
  814.      inserted into the buffer.
  815.  
  816. `C-z d   (documentation-lisp)'
  817.      Infers whether function or variable documentation is desired.
  818.      With a negative prefix, you can specify the type of documentation
  819.      as well.  With a positive prefix the documentation of the current
  820.      function call is inserted into the buffer.
  821.  
  822. `C-z i   (describe-lisp)'
  823.      Describe the previous sexp (it is evaluated).  If there is no
  824.      previous sexp and if called from inside an ILISP buffer, the
  825.      previous result will be described.
  826.  
  827. `C-z i   (describe-lisp)'
  828.      Describe the previous sexp (it is evaluated).  If there is no
  829.      previous sexp and if called from inside an ILISP buffer, the
  830.      previous result will be described.
  831.  
  832. `C-z I   (inspect-lisp)'
  833.      Switch to the current inferor LISP and inspect the previous sexp
  834.      (it is evaluated).  If there is no previous sexp and if called
  835.      from inside an ILISP buffer, the previous result will be inspected.
  836.  
  837. `C-z D   (fi:clman)'
  838. `C-z A   (fi:clman-apropos)'
  839.      If the Franz online Common LISP manual is available, get
  840.      information on a specific symbol.  `fi:clman-apropos' will get
  841.      information apropos a specific string.  Some of the documentation
  842.      is specific to the allegro dialect, but most of it is for standard
  843.      Common LISP.
  844.  
  845. 
  846. File: ilisp.info,  Node: Macroexpansion,  Next: Tracing functions,  Prev: Documentation functions,  Up: ILISP Commands
  847.  
  848. Macroexpansion
  849. ==============
  850.  
  851. `C-z M   (macroexpand-lisp)'
  852. `C-z m   (macroexpand-1-lisp)'
  853.      These commands apply to the next sexp.  If called with a positive
  854.      numeric prefix, the result of the macroexpansion will be inserted
  855.      into the buffer.  With a negative prefix, prompts for expression
  856.      to expand.
  857.  
  858. 
  859. File: ilisp.info,  Node: Tracing functions,  Next: Package Commands,  Prev: Macroexpansion,  Up: ILISP Commands
  860.  
  861. Tracing functions
  862. =================
  863.  
  864. `C-z t   (trace-defun-lisp)'
  865.      traces the current defun.   When called with a numeric prefix the
  866.      function will be untraced.  When called with negative prefix,
  867.      prompts for function to be traced.
  868.  
  869. 
  870. File: ilisp.info,  Node: Package Commands,  Next: Source code commands,  Prev: Tracing functions,  Up: ILISP Commands
  871.  
  872. Package Commands
  873. ================
  874.  
  875.    The first time an inferior LISP mode command is executed in a Lisp
  876. Mode buffer, the package will be determined by using the regular
  877. expression `ilisp-package-regexp' to find a package sexp and then
  878. passing that sexp to the inferior LISP through `ilisp-package-command'.
  879. For the `clisp' dialect, this will find the first `(in-package
  880. PACKAGE)' form in the file.  A buffer's package will be displayed in
  881. the mode line.  If a buffer has no specification, forms will be
  882. evaluated in the current inferior LISP package.
  883.  
  884.    Buffer package caching can be turned off by setting the variable
  885. `lisp-dont-cache-package' to `T'.  This will force ILISP to search for
  886. the closest previous `ilisp-package-regexp' in the buffer each time an
  887. inferior LISP mode command is executed.
  888.  
  889. `C-z p   (package-lisp)'
  890.      Show the current package of the inferior LISP.
  891.  
  892. `C-z P   (set-package-lisp)'
  893.      Set the inferior LISP package to the current buffer's package or
  894.      with a prefix to a manually entered package.
  895.  
  896. `M-x set-buffer-package-lisp'
  897.      Set the buffer's package from the buffer.  If it is called with a
  898.      prefix, the package can be set manually.
  899.  
  900. 
  901. File: ilisp.info,  Node: Source code commands,  Next: Batch commands,  Prev: Package Commands,  Up: ILISP Commands
  902.  
  903. Source Code Commands
  904. ====================
  905.  
  906.    The following commands all deal with finding things in source code.
  907. The first time that one of these commands is used, there may be some
  908. delay while the source module is loaded.  When searching files, the
  909. first applicable rule is used:
  910.    * try the inferior LISP,
  911.  
  912.    * try a tags file if defined,
  913.  
  914.    * try all buffers in one of `lisp-source-modes' or all files defined
  915.      using `lisp-directory'.
  916.  
  917.    `M-x lisp-directory' defines a set of files to be searched by the
  918. source code commands.  It prompts for a directory and sets the source
  919. files to be those in the directory that match entries in
  920. `auto-mode-alist' for modes in `lisp-source-modes'.  With a positive
  921. prefix, the files are appended.  With a negative prefix, all current
  922. buffers that are in one of `lisp-source-modes' will be searched.  This
  923. is also what happens by default.  Using this command stops using a tags
  924. file.
  925.  
  926.    `edit-definitions-lisp', `who-calls-lisp', and `edit-callers-lisp'
  927. will switch whether they prompt for a response or use a default when
  928. called with a negative prefix.  If they are prompting, there is
  929. completion through the inferior LISP by using `TAB' or `M-TAB'.  When
  930. entering an expression in the minibuffer, all of the normal ILISP
  931. commands like `arglist-lisp' also work.
  932.  
  933.    `edit-definitions-lisp' (`M-.') will find a particular type of
  934. definition for a symbol.  It tries to use the rules described above.
  935. The files to be searched are listed in the buffer `*Edit-Definitions*'.
  936. If `lisp-edit-files' is nil, no search will be done if not found
  937. through the inferior LISP.  The variable `ilisp-locator' contains a
  938. function that when given the name and type should be able to find the
  939. appropriate definition in the file.  There is often a flag to cause
  940. your LISP to record source files that you will need to set in the
  941. initialization file for your LISP.  The variable is
  942. `*record-source-files*' in both allegro and lucid.  Once a definition
  943. has been found, `next-definition-lisp' (`M-,') will find the next
  944. definition (or the previous definition with a prefix).
  945.  
  946.    `edit-callers-lisp' (`C-z ^') will generate a list of all of the
  947. callers of a function in the current inferior LISP and edit the first
  948. caller using `edit-definitions-lisp'.  Each successive call to
  949. `next-caller-lisp' (`M-`') will edit the next caller (or the previous
  950. caller with a prefix).  The list is stored in the buffer
  951. `*All-Callers*'.  You can also look at the callers by doing `M-x
  952. who-calls-lisp'.
  953.  
  954.    `search-lisp' (`M-?') will search the current tags files,
  955. `lisp-directory' files or buffers in one of `lisp-source-modes' for a
  956. string or a regular expression when called with a prefix.
  957. `next-definition-lisp' (`M-,') will find the next definition (or the
  958. previous definition with a prefix).
  959.  
  960.    `replace-lisp' (`M-"') will replace a string (or a regexp with a
  961. prefix) in the current tags files, `lisp-directory' files or buffers in
  962. one of `lisp-source-modes'.
  963.  
  964.    Here is a summary of the above commands (behavior when given prefix
  965. argument is given in parentheses):
  966.  
  967. `M-x lisp-directory'
  968.      Define a set of files to be used by the source code commands.
  969.  
  970. `M-.   (edit-definitions-lisp)'
  971.      Find definition of a symbol.
  972.  
  973. `M-,   (next-definition-lisp)'
  974.      Find next (previous) definition.
  975.  
  976. `C-z ^   (edit-callers-lisp)'
  977.      Find all callers of a function, and edit the first.
  978.  
  979. `M-`   (next-caller-lisp)'
  980.      Edit next (previous) caller of function set by `edit-callers-lisp'.
  981.  
  982. `M-x who-calls-lisp'
  983.      List all the callers of a function.
  984.  
  985. `M-?   (search-lisp)'
  986.      Search for string (regular expression) in current tags,
  987.      `lisp-directory' files or buffers.  Use `next-definition-lisp' to
  988.      find next occurence.
  989.  
  990. `M-"   (replace-lisp)'
  991.      Replace a string (regular expression) in files.
  992.  
  993. 
  994. File: ilisp.info,  Node: Batch commands,  Next: Files and directories,  Prev: Source code commands,  Up: ILISP Commands
  995.  
  996. Batch commands
  997. ==============
  998.  
  999.    The following commands all deal with making a number of changes all
  1000. at once.  The first time one of these commands is used, there may be
  1001. some delay as the module is loaded.  The eval/compile versions of these
  1002. commands are always executed asynchronously.
  1003.  
  1004.    `mark-change-lisp' (`C-z SPC') marks the current defun as being
  1005. changed.  A prefix causes it to be unmarked.  `clear-changes-lisp'
  1006. (`C-z * 0') will clear all of the changes.  `list-changes-lisp' (`C-z *
  1007. l') will show the forms currently marked.
  1008.  
  1009.    `eval-changes-lisp' (`C-z * e'), or `compile-changes-lisp' (`C-z *
  1010. c') will evaluate or compile these changes as appropriate.  If called
  1011. with a positive prefix, the changes will be kept.  If there is an
  1012. error, the process will stop and show the error and all remaining
  1013. changes will remain in the list.  All of the results will be kept in
  1014. the buffer `*Last-Changes*'.
  1015.  
  1016. Summary:
  1017.  
  1018. `C-z SPC   (mark-change-lisp)'
  1019.      Mark (unmark) current defun as changed.
  1020.  
  1021. `C-z * e   (eval-changes-lisp)'
  1022. `C-z * c   (compile-changes-lisp)'
  1023.      Call with a positive prefix to keep changes.
  1024.  
  1025. `C-z * 0   (clear-changes-lisp)'
  1026. `C-z * l   (list-changes-lisp)'
  1027. 
  1028. File: ilisp.info,  Node: Files and directories,  Next: Keyboard modes,  Prev: Batch commands,  Up: ILISP Commands
  1029.  
  1030. Files and directories
  1031. =====================
  1032.  
  1033.    File commands in lisp-source-mode buffers keep track of the last used
  1034. directory and file.  If the point is on a string, that will be the
  1035. default if the file exists.  If the buffer is one of
  1036. `lisp-source-modes', the buffer file will be the default.  Otherwise,
  1037. the last file used in a lisp-source-mode will be used.
  1038.  
  1039. `C-x C-f   (find-file-lisp)'
  1040.      will find a file.  If it is in a string, that will be used as the
  1041.      default if it matches an existing file.  Symbolic links are
  1042.      expanded so that different references to the same file will end up
  1043.      with the same buffer.
  1044.  
  1045. `C-z l   (load-file-lisp)'
  1046.      will load a file into the inferior LISP.  You will be given the
  1047.      opportunity to save the buffer if it has changed and to compile
  1048.      the file if the compiled version is older than the current version.
  1049.  
  1050. `C-z k   (compile-file-lisp)'
  1051.      will compile a file in the current inferior LISP.
  1052.  
  1053. `C-z !   (default-directory-lisp)'
  1054.      sets the default inferior LISP directory to the directory of the
  1055.      current buffer.  If called in an inferior LISP buffer, it sets the
  1056.      Emacs `default-directory' to the LISP default directory.
  1057.  
  1058. 
  1059. File: ilisp.info,  Node: Keyboard modes,  Next: Interrupts,  Prev: Files and directories,  Up: ILISP Commands
  1060.  
  1061. Switching between interactive and raw keyboard modes
  1062. ====================================================
  1063.  
  1064.    There are two keyboard modes for interacting with the inferior LISP,
  1065. \"interactive\" and \"raw\".  Normally you are in interactive mode
  1066. where keys are interpreted as commands to EMACS and nothing is sent to
  1067. the inferior LISP unless a specific command does so.  In raw mode, all
  1068. characters are passed directly to the inferior LISP without any
  1069. interpretation as EMACS commands.  Keys will not be echoed unless
  1070. ilisp-raw-echo is T.
  1071.  
  1072.    Raw mode can be turned on interactively by the command
  1073. `raw-keys-ilisp' (`C-z #') and will continue until you type C-g.  Raw
  1074. mode can also be turned on/off by inferior LISP functions if the
  1075. command `io-bridge-ilisp' (M-x io-bridge-ilisp) has been executed in
  1076. the inferior LISP either interactively or on a hook.  To turn on raw
  1077. mode, a function should print ^[1^] and to turn it off should print
  1078. ^[0^].  An example in Common LISP would be:
  1079.  
  1080.    `(progn (format t "") (print (read-char)) (format t ""))'
  1081.  
  1082. 
  1083. File: ilisp.info,  Node: Interrupts,  Next: Command history,  Prev: Keyboard modes,  Up: ILISP Commands
  1084.  
  1085. Interrupts, aborts, and errors
  1086. ==============================
  1087.  
  1088.    If you want to abort the last command you can use `C-g'.
  1089.  
  1090.    If you want to abort all commands, you should use the command
  1091. `abort-commands-lisp' (`C-z g').  Commands that are aborted will be put
  1092. in the buffer `*Aborted Commands*' so that you can see what was
  1093. aborted.  If you want to abort the currently running top-level command,
  1094. use `interrupt-subjob-ilisp' (`C-c C-c').  As a last resort, `M-x
  1095. panic-lisp' will reset the ILISP state without affecting the inferior
  1096. LISP so that you can see what is happening.
  1097.  
  1098.    `delete-char-or-pop-ilisp' (`C-d') will delete prefix characters
  1099. unless you are at the end of an ILISP buffer in which case it will pop
  1100. one level in the break loop.
  1101.  
  1102.    `reset-ilisp', (`C-z z') will reset the current inferior LISP's
  1103. top-level so that it will no longer be in a break loop.
  1104.  
  1105.    Summary:
  1106.  
  1107. `C-c C-c   (interrupt-subjob-ilisp)'
  1108.      Send a keyboard interrupt signal to lisp.
  1109.  
  1110. `C-z g    (abort-commands-lisp)'
  1111.      Abort all running or unsent commands.
  1112.  
  1113. `M-x panic-lisp (panic-lisp)'
  1114.      Reset the ILISP process state.
  1115.  
  1116. `C-z z   (reset-ilisp)'
  1117.      Reset lisp to top-level.
  1118.  
  1119. `C-d   (delete-char-or-pop-ilisp)'
  1120.      If at end of buffer, pop a level in break loop.
  1121.  
  1122.    If `lisp-wait-p' is `nil'  (the default), all sends are done
  1123. asynchronously and the results will be brought up only if there is more
  1124. than one line or there is an error.  In case, you will be given the
  1125. option of ignoring the error, keeping it in another buffer or keeping
  1126. it and aborting all pending sends.  If there is not a command already
  1127. running in the inferior LISP, you can preserve the break loop.  If
  1128. called with a negative prefix, the sense of `lisp-wait-p' will be
  1129. inverted for the next command.
  1130.  
  1131. 
  1132. File: ilisp.info,  Node: Command history,  Next: Completion,  Prev: Interrupts,  Up: ILISP Commands
  1133.  
  1134. Command history
  1135. ===============
  1136.  
  1137.    ILISP mode is built on top of `comint-mode', the general
  1138. command-interpreter-in-a-buffer mode.  As such, it inherits many
  1139. commands and features from this, including a command history mechanism.
  1140.  
  1141.    Each ILISP buffer has a command history associated with it.  Commands
  1142. that do not match `ilisp-filter-regexp' and that are longer than
  1143. `ilisp-filter-length' and that do not match the immediately prior
  1144. command will be added to this history.
  1145.  
  1146. `M-n   (comint-next-input)'
  1147. `M-p   (comint-previous-input)'
  1148.      Cycle through the input history.
  1149.  
  1150. `M-s    (comint-previous-similar-input)'
  1151.      Cycle through input that has the string typed so far as a prefix.
  1152.  
  1153. `M-N    (comint-psearch-input)'
  1154.      Search forwards for prompt.
  1155.  
  1156. `M-P    (comint-msearch-input)'
  1157.      Search backwards for prompt.
  1158.  
  1159. `C-c R   (comint-msearch-input-matching)'
  1160.      Search backwards for occurrence of prompt followed by string which
  1161.      is prompted for (*not* a regular expression).
  1162.  
  1163.    See `comint-mode' documentation for more information on `comint'
  1164. commands.
  1165.  
  1166. 
  1167. File: ilisp.info,  Node: Completion,  Next: Miscellany,  Prev: Command history,  Up: ILISP Commands
  1168.  
  1169. Completion
  1170. ==========
  1171.  
  1172.    Commands to reduce number of keystrokes.
  1173.  
  1174. `M-TAB   (complete-lisp)'
  1175.      will try to complete the previous symbol in the current inferior
  1176.      LISP.  Partial completion is supported unless `ilisp-prefix-match'
  1177.      is set to `t'.  (If you set it to `t', inferior LISP completions
  1178.      will be faster.) With partial completion, `p--n' would complete to
  1179.      `position-if-not' in Common LISP.  If the symbol follows a left
  1180.      paren or a `#'', only symbols with function cells will be
  1181.      considered.  If the symbol starts with a `*' or you call with a
  1182.      positive prefix all possible completions will be considered.  Only
  1183.      external symbols are considered if there is a package qualification
  1184.      with only one colon.  The first time you try to complete a string
  1185.      the longest common substring will be inserted and the cursor will
  1186.      be left on the point of ambiguity.  If you try to complete again,
  1187.      you can see the possible completions.  If you are in a string,
  1188.      then filename completion will be done instead.  And if you try to
  1189.      complete a filename twice, you will see a list of possible
  1190.      completions.  Filename components are completed individually, so
  1191.      `/u/mi/' could expand to `/usr/misc/'.  If you complete with a
  1192.      negative prefix, the most recent completion (symbol or filename)
  1193.      will be undone.
  1194.  
  1195. `M-RET   (complete)'
  1196.      will complete the current symbol to the most recently seen symbol
  1197.      in Emacs that matches what you have typed so far.  Executing it
  1198.      repeatedly will cycle through potential matches.  This is from the
  1199.      TMC completion package and there may be some delay as it is
  1200.      initially loaded.
  1201.  
  1202. 
  1203. File: ilisp.info,  Node: Miscellany,  Prev: Completion,  Up: ILISP Commands
  1204.  
  1205. Miscellany
  1206. ==========
  1207.  
  1208.    Indentation, parenthesis balancing, and comment commands.
  1209.  
  1210. ``TAB'   (indent-line-ilisp)'
  1211.      indents for LISP.  With prefix, shifts rest of expression rigidly
  1212.      with the current line.
  1213.  
  1214. `M-C-q   (indent-sexp-ilisp)'
  1215.      will indent each line in the next sexp.
  1216.  
  1217. `M-q   (reindent-lisp)'
  1218.      will reindent the current paragraph if in a comment or string.
  1219.      Otherwise it will close the containing defun and reindent it.
  1220.  
  1221. `C-z ;   (comment-region-lisp)'
  1222.      will put prefix copies of `comment-start' before and
  1223.      `comment-end''s after the lines in region.  To uncomment a region,
  1224.      use a minus prefix.
  1225.  
  1226. `C-z )   (find-unbalanced-lisp)'
  1227.      will find unbalanced parens in the current buffer.  When called
  1228.      with a prefix it will look in the current region.
  1229.  
  1230. `]   (close-all-lisp)'
  1231.      will close all outstanding parens back to the containing form, or a
  1232.      previous left bracket which will be converted to a left parens.  If
  1233.      there are too many parens, they will be deleted unless there is
  1234.      text between the last paren and the end of the defun.  If called
  1235.      with a prefix, all open left brackets will be closed.
  1236.  
  1237. 
  1238. File: ilisp.info,  Node: Customization,  Next: Dialects,  Prev: ILISP Commands,  Up: Top
  1239.  
  1240. ILISP Customization
  1241. *******************
  1242.  
  1243.    Starting a dialect runs the hooks on `comint-mode-hook' and
  1244. `ilisp-mode-hook' and then DIALECT`-hooks' specific to dialects in the
  1245. nesting order below.
  1246.       clisp
  1247.         allegro
  1248.         lucid
  1249.         kcl
  1250.           akcl
  1251.           ibcl
  1252.         cmulisp
  1253.       scheme
  1254.         oaklisp
  1255.  
  1256.    On the very first prompt in the inferior LISP, the hooks on
  1257. `ilisp-init-hook' are run.  For more information on creating a new
  1258. dialect or variables to set in hooks, see `ilisp.el'.
  1259.  
  1260.    ILISP Mode Hooks:
  1261. `ilisp-site-hook'
  1262.      Executed when file is loaded
  1263.  
  1264. `ilisp-load-hook'
  1265.      Executed when file is loaded
  1266.  
  1267. `ilisp-mode-hook'
  1268.      Executed when an ilisp buffer is created
  1269.  
  1270. `ilisp-init-hook'
  1271.      Executed after inferior LISP is initialized and the first prompt is
  1272.      seen.
  1273.  
  1274. `DIALECT-hook'
  1275.      Executed when dialect is set
  1276.  
  1277.    Variables you might want to set in a hook or dialect:
  1278. `ilisp-prefix'
  1279.      Keys to prefix ilisp key bindings
  1280.  
  1281. `ilisp-program'
  1282.      Program to start for inferior LISP
  1283.  
  1284. `ilisp-motd'
  1285.      String printed on startup with version
  1286.  
  1287. `lisp-wait-p'
  1288.      Set to T for synchronous sends
  1289.  
  1290. `ilisp-handle-errors'
  1291.      Set to T for ilisp to handle errors from the underlying lisp.
  1292.  
  1293. `ilisp-display-output-function'
  1294.      The name of a function which displays ILISP output.
  1295.  
  1296. `lisp-no-popper'
  1297.      Set to T to have all output in inferior LISP
  1298.  
  1299. `lisp-show-status'
  1300.      Set to nil to stop showing process status
  1301.  
  1302. `ilisp-prefix-match'
  1303.      Set to T if you do not want partial completion
  1304.  
  1305. `ilisp-filter-regexp'
  1306.      Input history filter
  1307.  
  1308. `ilisp-filter-length'
  1309.      Input history minimum length
  1310.  
  1311. `ilisp-other-prompt'
  1312.      Prompt for non- top-level read-eval print loops
  1313.  
  1314. 
  1315. File: ilisp.info,  Node: Dialects,  Next: Concept index,  Prev: Customization,  Up: Top
  1316.  
  1317. Dialects
  1318. ********
  1319.  
  1320.    A "dialect" of lisp is a specific implementation.  For the parts of
  1321. Common Lisp which are well specified, they are usually the same.  For
  1322. the parts that are not (debugger, top-level loop, etc.), there is
  1323. usually the same functionality but different commands.
  1324.  
  1325.    ILISP provides the means to specify these differences so that the
  1326. ILISP commands will use the specific command peculiar to an
  1327. implementation, but still offer the same behavior with the same
  1328. interface.
  1329.  
  1330. * Menu:
  1331.  
  1332. * Defining new dialects::
  1333. * Writing new commands::
  1334.  
  1335. 
  1336. File: ilisp.info,  Node: Defining new dialects,  Next: Writing new commands,  Up: Dialects
  1337.  
  1338. Defining new dialects
  1339. =====================
  1340.  
  1341.    To define a new dialect use the macro `defdialect'.  For examples,
  1342. look at the dialect definitions in `ilisp-acl.el', `ilisp-cmu.el',
  1343. `ilisp-kcl.el', `ilisp-luc'.  There are hooks and variables for almost
  1344. anything that you are likely to need to change.  The relationship
  1345. between dialects is hierarchical with the root values being defined in
  1346. `setup-ilisp'.  For a new dialect, you only need to change the
  1347. variables that are different than in the parent dialect.
  1348.  
  1349. 
  1350. File: ilisp.info,  Node: Writing new commands,  Prev: Defining new dialects,  Up: Dialects
  1351.  
  1352. Writing new commands
  1353. ====================
  1354.  
  1355.    Basic tools for creating new commands:
  1356. `deflocal'
  1357.      Define a new buffer local variable.
  1358.  
  1359. `ilisp-dialect'
  1360.      List of dialect types.  For specific dialect clauses.
  1361.  
  1362. `lisp-symbol'
  1363.      Create a symbol.
  1364.  
  1365. `lisp-symbol-name'
  1366.      Return a symbol's name
  1367.  
  1368. `lisp-symbol-delimiter'
  1369.      Return a symbol's qualification
  1370.  
  1371. `lisp-symbol-package'
  1372.      Return a symbol's package
  1373.  
  1374. `lisp-string-to-symbol'
  1375.      Convert string to symbol
  1376.  
  1377. `lisp-symbol-to-string'
  1378.      Convert symbol to string
  1379.  
  1380. `lisp-buffer-symbol'
  1381.      Convert symbol to string qualified for buffer
  1382.  
  1383. `lisp-previous-symbol'
  1384.      Return previous symbol
  1385.  
  1386. `lisp-previous-sexp'
  1387.      Return previous sexp
  1388.  
  1389. `lisp-def-name'
  1390.      Return name of current definition
  1391.  
  1392. `lisp-function-name'
  1393.      Return previous function symbol
  1394.  
  1395. `ilisp-read'
  1396.      Read an sexp with completion, arglist, etc
  1397.  
  1398. `ilisp-read-symbol'
  1399.      Read a symbol or list with completion
  1400.  
  1401. `ilisp-completing-read'
  1402.      Read from choices or list with completion
  1403.  
  1404. Notes:
  1405.    * Special commands like arglist should use `ilisp-send' to send a
  1406.      message to the inferior LISP.
  1407.  
  1408.    * Eval/compile commands should use `eval-region-lisp' or
  1409.      `compile-region-lisp'.
  1410.  
  1411.